Skip to main content

Location Query

Description

The PatientSearch Location Query is used to search for external locations and identifiers of a patient in another system, using a known patient identifier as the search criteria. This query can be useful in identifying other locations where the patient may have clinical information stored. The response from this query typically includes information about external locations, such as facility names, identifiers, addresses, contact information, and other relevant details.

API endpoints for Location Query

Sync REST API Endpoint to call the API: https://{base_url}/api/v1/patient-search/location-query.

Async REST API Endpoint to call the API: https://{base_url}/api/v1/endpoint.

Data Model JSON for Location Query

Location Query - Sample Payload

{
"Meta": {
"DataModel": "PatientSearch",
"EventType": "LocationQuery",
"EventDateTime": "2022-08-16T14:21:20.733Z",
"Test": true,
"Destinations": [
{
"ID": "2875a7fe-93d1-4772-8b40-b8c898283c06",
"Name": "Destinations EMR"
}
],
"Logs": [
{
"ID": "835ab295-c20c-412f-8428-d7e9012adb71",
"AttemptID": "246bc713-0e62-420d-bb95-88ede891f646"
}
],
"FacilityCode": null
},
"Patient": {
"Identifiers": [
{
"ID": "0000000001",
"IDType": "MR"
},
{
"ID": "6a3353d8-2675-486f-8f73-885e715d45df",
"IDType": "EHRID"
},
{
"ID": "6bcb4ba2-7d1d-479c-be5e-4c6013eb0981",
"IDType": "NIST"
}
]
}
}